<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Copyright (C) 2009 The Guava Authors<a name="line.2"></a>
<span class="sourceLineNo">003</span> *<a name="line.3"></a>
<span class="sourceLineNo">004</span> * Licensed under the Apache License, Version 2.0 (the "License");<a name="line.4"></a>
<span class="sourceLineNo">005</span> * you may not use this file except in compliance with the License.<a name="line.5"></a>
<span class="sourceLineNo">006</span> * You may obtain a copy of the License at<a name="line.6"></a>
<span class="sourceLineNo">007</span> *<a name="line.7"></a>
<span class="sourceLineNo">008</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * Unless required by applicable law or agreed to in writing, software<a name="line.10"></a>
<span class="sourceLineNo">011</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.11"></a>
<span class="sourceLineNo">012</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.12"></a>
<span class="sourceLineNo">013</span> * See the License for the specific language governing permissions and<a name="line.13"></a>
<span class="sourceLineNo">014</span> * limitations under the License.<a name="line.14"></a>
<span class="sourceLineNo">015</span> */<a name="line.15"></a>
<span class="sourceLineNo">016</span><a name="line.16"></a>
<span class="sourceLineNo">017</span>package com.google.common.util.concurrent;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import com.google.common.annotations.Beta;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import com.google.common.base.Throwables;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.util.concurrent.Executor;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.logging.Level;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.logging.Logger;<a name="line.24"></a>
<span class="sourceLineNo">025</span><a name="line.25"></a>
<span class="sourceLineNo">026</span>/**<a name="line.26"></a>
<span class="sourceLineNo">027</span> * Base class for services that can implement {@link #startUp}, {@link #run} and<a name="line.27"></a>
<span class="sourceLineNo">028</span> * {@link #shutDown} methods. This class uses a single thread to execute the<a name="line.28"></a>
<span class="sourceLineNo">029</span> * service; consider {@link AbstractService} if you would like to manage any<a name="line.29"></a>
<span class="sourceLineNo">030</span> * threading manually.<a name="line.30"></a>
<span class="sourceLineNo">031</span> *<a name="line.31"></a>
<span class="sourceLineNo">032</span> * @author Jesse Wilson<a name="line.32"></a>
<span class="sourceLineNo">033</span> * @since 1.0<a name="line.33"></a>
<span class="sourceLineNo">034</span> */<a name="line.34"></a>
<span class="sourceLineNo">035</span>@Beta<a name="line.35"></a>
<span class="sourceLineNo">036</span>public abstract class AbstractExecutionThreadService implements Service {<a name="line.36"></a>
<span class="sourceLineNo">037</span>  private static final Logger logger = Logger.getLogger(<a name="line.37"></a>
<span class="sourceLineNo">038</span>      AbstractExecutionThreadService.class.getName());<a name="line.38"></a>
<span class="sourceLineNo">039</span><a name="line.39"></a>
<span class="sourceLineNo">040</span>  /* use AbstractService for state management */<a name="line.40"></a>
<span class="sourceLineNo">041</span>  private final Service delegate = new AbstractService() {<a name="line.41"></a>
<span class="sourceLineNo">042</span>    @Override protected final void doStart() {<a name="line.42"></a>
<span class="sourceLineNo">043</span>      executor().execute(new Runnable() {<a name="line.43"></a>
<span class="sourceLineNo">044</span>        @Override<a name="line.44"></a>
<span class="sourceLineNo">045</span>        public void run() {<a name="line.45"></a>
<span class="sourceLineNo">046</span>          try {<a name="line.46"></a>
<span class="sourceLineNo">047</span>            startUp();<a name="line.47"></a>
<span class="sourceLineNo">048</span>            notifyStarted();<a name="line.48"></a>
<span class="sourceLineNo">049</span><a name="line.49"></a>
<span class="sourceLineNo">050</span>            if (isRunning()) {<a name="line.50"></a>
<span class="sourceLineNo">051</span>              try {<a name="line.51"></a>
<span class="sourceLineNo">052</span>                AbstractExecutionThreadService.this.run();<a name="line.52"></a>
<span class="sourceLineNo">053</span>              } catch (Throwable t) {<a name="line.53"></a>
<span class="sourceLineNo">054</span>                try {<a name="line.54"></a>
<span class="sourceLineNo">055</span>                  shutDown();<a name="line.55"></a>
<span class="sourceLineNo">056</span>                } catch (Exception ignored) {<a name="line.56"></a>
<span class="sourceLineNo">057</span>                  logger.log(Level.WARNING,<a name="line.57"></a>
<span class="sourceLineNo">058</span>                      "Error while attempting to shut down the service"<a name="line.58"></a>
<span class="sourceLineNo">059</span>                      + " after failure.", ignored);<a name="line.59"></a>
<span class="sourceLineNo">060</span>                }<a name="line.60"></a>
<span class="sourceLineNo">061</span>                throw t;<a name="line.61"></a>
<span class="sourceLineNo">062</span>              }<a name="line.62"></a>
<span class="sourceLineNo">063</span>            }<a name="line.63"></a>
<span class="sourceLineNo">064</span><a name="line.64"></a>
<span class="sourceLineNo">065</span>            shutDown();<a name="line.65"></a>
<span class="sourceLineNo">066</span>            notifyStopped();<a name="line.66"></a>
<span class="sourceLineNo">067</span>          } catch (Throwable t) {<a name="line.67"></a>
<span class="sourceLineNo">068</span>            notifyFailed(t);<a name="line.68"></a>
<span class="sourceLineNo">069</span>            throw Throwables.propagate(t);<a name="line.69"></a>
<span class="sourceLineNo">070</span>          }<a name="line.70"></a>
<span class="sourceLineNo">071</span>        }<a name="line.71"></a>
<span class="sourceLineNo">072</span>      });<a name="line.72"></a>
<span class="sourceLineNo">073</span>    }<a name="line.73"></a>
<span class="sourceLineNo">074</span><a name="line.74"></a>
<span class="sourceLineNo">075</span>    @Override protected void doStop() {<a name="line.75"></a>
<span class="sourceLineNo">076</span>      triggerShutdown();<a name="line.76"></a>
<span class="sourceLineNo">077</span>    }<a name="line.77"></a>
<span class="sourceLineNo">078</span>  };<a name="line.78"></a>
<span class="sourceLineNo">079</span><a name="line.79"></a>
<span class="sourceLineNo">080</span>  /**<a name="line.80"></a>
<span class="sourceLineNo">081</span>   * Constructor for use by subclasses.<a name="line.81"></a>
<span class="sourceLineNo">082</span>   */<a name="line.82"></a>
<span class="sourceLineNo">083</span>  protected AbstractExecutionThreadService() {}<a name="line.83"></a>
<span class="sourceLineNo">084</span><a name="line.84"></a>
<span class="sourceLineNo">085</span>  /**<a name="line.85"></a>
<span class="sourceLineNo">086</span>   * Start the service. This method is invoked on the execution thread.<a name="line.86"></a>
<span class="sourceLineNo">087</span>   *<a name="line.87"></a>
<span class="sourceLineNo">088</span>   * &lt;p&gt;By default this method does nothing.<a name="line.88"></a>
<span class="sourceLineNo">089</span>   */<a name="line.89"></a>
<span class="sourceLineNo">090</span>  protected void startUp() throws Exception {}<a name="line.90"></a>
<span class="sourceLineNo">091</span><a name="line.91"></a>
<span class="sourceLineNo">092</span>  /**<a name="line.92"></a>
<span class="sourceLineNo">093</span>   * Run the service. This method is invoked on the execution thread.<a name="line.93"></a>
<span class="sourceLineNo">094</span>   * Implementations must respond to stop requests. You could poll for lifecycle<a name="line.94"></a>
<span class="sourceLineNo">095</span>   * changes in a work loop:<a name="line.95"></a>
<span class="sourceLineNo">096</span>   * &lt;pre&gt;<a name="line.96"></a>
<span class="sourceLineNo">097</span>   *   public void run() {<a name="line.97"></a>
<span class="sourceLineNo">098</span>   *     while ({@link #isRunning()}) {<a name="line.98"></a>
<span class="sourceLineNo">099</span>   *       // perform a unit of work<a name="line.99"></a>
<span class="sourceLineNo">100</span>   *     }<a name="line.100"></a>
<span class="sourceLineNo">101</span>   *   }<a name="line.101"></a>
<span class="sourceLineNo">102</span>   * &lt;/pre&gt;<a name="line.102"></a>
<span class="sourceLineNo">103</span>   * ...or you could respond to stop requests by implementing {@link<a name="line.103"></a>
<span class="sourceLineNo">104</span>   * #triggerShutdown()}, which should cause {@link #run()} to return.<a name="line.104"></a>
<span class="sourceLineNo">105</span>   */<a name="line.105"></a>
<span class="sourceLineNo">106</span>  protected abstract void run() throws Exception;<a name="line.106"></a>
<span class="sourceLineNo">107</span><a name="line.107"></a>
<span class="sourceLineNo">108</span>  /**<a name="line.108"></a>
<span class="sourceLineNo">109</span>   * Stop the service. This method is invoked on the execution thread.<a name="line.109"></a>
<span class="sourceLineNo">110</span>   *<a name="line.110"></a>
<span class="sourceLineNo">111</span>   * &lt;p&gt;By default this method does nothing.<a name="line.111"></a>
<span class="sourceLineNo">112</span>   */<a name="line.112"></a>
<span class="sourceLineNo">113</span>  // TODO: consider supporting a TearDownTestCase-like API<a name="line.113"></a>
<span class="sourceLineNo">114</span>  protected void shutDown() throws Exception {}<a name="line.114"></a>
<span class="sourceLineNo">115</span><a name="line.115"></a>
<span class="sourceLineNo">116</span>  /**<a name="line.116"></a>
<span class="sourceLineNo">117</span>   * Invoked to request the service to stop.<a name="line.117"></a>
<span class="sourceLineNo">118</span>   *<a name="line.118"></a>
<span class="sourceLineNo">119</span>   * &lt;p&gt;By default this method does nothing.<a name="line.119"></a>
<span class="sourceLineNo">120</span>   */<a name="line.120"></a>
<span class="sourceLineNo">121</span>  protected void triggerShutdown() {}<a name="line.121"></a>
<span class="sourceLineNo">122</span><a name="line.122"></a>
<span class="sourceLineNo">123</span>  /**<a name="line.123"></a>
<span class="sourceLineNo">124</span>   * Returns the {@link Executor} that will be used to run this service.<a name="line.124"></a>
<span class="sourceLineNo">125</span>   * Subclasses may override this method to use a custom {@link Executor}, which<a name="line.125"></a>
<span class="sourceLineNo">126</span>   * may configure its worker thread with a specific name, thread group or<a name="line.126"></a>
<span class="sourceLineNo">127</span>   * priority. The returned executor's {@link Executor#execute(Runnable)<a name="line.127"></a>
<span class="sourceLineNo">128</span>   * execute()} method is called when this service is started, and should return<a name="line.128"></a>
<span class="sourceLineNo">129</span>   * promptly.<a name="line.129"></a>
<span class="sourceLineNo">130</span>   *<a name="line.130"></a>
<span class="sourceLineNo">131</span>   * &lt;p&gt;The default implementation returns a new {@link Executor} that sets the<a name="line.131"></a>
<span class="sourceLineNo">132</span>   * name of its threads to the string returned by {@link #serviceName}<a name="line.132"></a>
<span class="sourceLineNo">133</span>   */<a name="line.133"></a>
<span class="sourceLineNo">134</span>  protected Executor executor() {<a name="line.134"></a>
<span class="sourceLineNo">135</span>    return new Executor() {<a name="line.135"></a>
<span class="sourceLineNo">136</span>      @Override<a name="line.136"></a>
<span class="sourceLineNo">137</span>      public void execute(Runnable command) {<a name="line.137"></a>
<span class="sourceLineNo">138</span>        MoreExecutors.newThread(serviceName(), command).start();<a name="line.138"></a>
<span class="sourceLineNo">139</span>      }<a name="line.139"></a>
<span class="sourceLineNo">140</span>    };<a name="line.140"></a>
<span class="sourceLineNo">141</span>  }<a name="line.141"></a>
<span class="sourceLineNo">142</span><a name="line.142"></a>
<span class="sourceLineNo">143</span>  @Override public String toString() {<a name="line.143"></a>
<span class="sourceLineNo">144</span>    return serviceName() + " [" + state() + "]";<a name="line.144"></a>
<span class="sourceLineNo">145</span>  }<a name="line.145"></a>
<span class="sourceLineNo">146</span><a name="line.146"></a>
<span class="sourceLineNo">147</span>  // We override instead of using ForwardingService so that these can be final.<a name="line.147"></a>
<span class="sourceLineNo">148</span><a name="line.148"></a>
<span class="sourceLineNo">149</span>  @Override public final ListenableFuture&lt;State&gt; start() {<a name="line.149"></a>
<span class="sourceLineNo">150</span>    return delegate.start();<a name="line.150"></a>
<span class="sourceLineNo">151</span>  }<a name="line.151"></a>
<span class="sourceLineNo">152</span><a name="line.152"></a>
<span class="sourceLineNo">153</span>  @Override public final State startAndWait() {<a name="line.153"></a>
<span class="sourceLineNo">154</span>    return delegate.startAndWait();<a name="line.154"></a>
<span class="sourceLineNo">155</span>  }<a name="line.155"></a>
<span class="sourceLineNo">156</span><a name="line.156"></a>
<span class="sourceLineNo">157</span>  @Override public final boolean isRunning() {<a name="line.157"></a>
<span class="sourceLineNo">158</span>    return delegate.isRunning();<a name="line.158"></a>
<span class="sourceLineNo">159</span>  }<a name="line.159"></a>
<span class="sourceLineNo">160</span><a name="line.160"></a>
<span class="sourceLineNo">161</span>  @Override public final State state() {<a name="line.161"></a>
<span class="sourceLineNo">162</span>    return delegate.state();<a name="line.162"></a>
<span class="sourceLineNo">163</span>  }<a name="line.163"></a>
<span class="sourceLineNo">164</span><a name="line.164"></a>
<span class="sourceLineNo">165</span>  @Override public final ListenableFuture&lt;State&gt; stop() {<a name="line.165"></a>
<span class="sourceLineNo">166</span>    return delegate.stop();<a name="line.166"></a>
<span class="sourceLineNo">167</span>  }<a name="line.167"></a>
<span class="sourceLineNo">168</span><a name="line.168"></a>
<span class="sourceLineNo">169</span>  @Override public final State stopAndWait() {<a name="line.169"></a>
<span class="sourceLineNo">170</span>    return delegate.stopAndWait();<a name="line.170"></a>
<span class="sourceLineNo">171</span>  }<a name="line.171"></a>
<span class="sourceLineNo">172</span><a name="line.172"></a>
<span class="sourceLineNo">173</span>  @Override public final void addListener(Listener listener, Executor executor) {<a name="line.173"></a>
<span class="sourceLineNo">174</span>    delegate.addListener(listener, executor);<a name="line.174"></a>
<span class="sourceLineNo">175</span>  }<a name="line.175"></a>
<span class="sourceLineNo">176</span><a name="line.176"></a>
<span class="sourceLineNo">177</span>  /**<a name="line.177"></a>
<span class="sourceLineNo">178</span>   * Returns the name of this service. {@link AbstractExecutionThreadService}<a name="line.178"></a>
<span class="sourceLineNo">179</span>   * may include the name in debugging output.<a name="line.179"></a>
<span class="sourceLineNo">180</span>   *<a name="line.180"></a>
<span class="sourceLineNo">181</span>   * &lt;p&gt;Subclasses may override this method.<a name="line.181"></a>
<span class="sourceLineNo">182</span>   *<a name="line.182"></a>
<span class="sourceLineNo">183</span>   * @since 14.0 (present in 10.0 as getServiceName)<a name="line.183"></a>
<span class="sourceLineNo">184</span>   */<a name="line.184"></a>
<span class="sourceLineNo">185</span>  protected String serviceName() {<a name="line.185"></a>
<span class="sourceLineNo">186</span>    return getClass().getSimpleName();<a name="line.186"></a>
<span class="sourceLineNo">187</span>  }<a name="line.187"></a>
<span class="sourceLineNo">188</span>}<a name="line.188"></a>




























































</pre>
</div>
</body>
</html>
